Search results

Types

Classes
Interfaces
Enums
Functions
Type aliases
Constants

Members

Properties
Methods
Getters
Setters
Enum members
Show privates

Other

In this module only
index / detritus-client / command / Command

Class Command

<ParsedArgsFinished = ParsedArgstype ParsedArgsdetritus-client/command/ParsedArgs>

Defined in command

Command itself Command flow is ratelimit check -> dm/permission check -> onBefore -> arg parse -> onBeforeRun -> run -> onSuccess | onRunError

Constructor

constructor(
commandClient: CommandClientclass CommandClientdetritus-client/CommandClient,
options: CommandOptionsinterface CommandOptionsdetritus-client/command/CommandOptions
)

Properties

argParser = ArgumentParserclass ArgumentParserdetritus-client/command/ArgumentParser[src]
commandClient: CommandClientclass CommandClientdetritus-client/CommandClient[src]
arg: Argumentclass Argumentdetritus-client/command/Argument[src]
metadata: Record<string, any>external Record = {}[src]
permissions?: Array<bigint>external Array[src]
ratelimits: Array<CommandRatelimitclass CommandRatelimitdetritus-client/commandratelimit/CommandRatelimit>external Array = Array<never>external Array[src]

Methods

onDmBlocked(
context: Contextclass Contextdetritus-client/command/Context
): Promise<any | Messageclass Messagedetritus-client/structures/Message>external Promise | any | Messageclass Messagedetritus-client/structures/Message[src]
onBefore(
context: Contextclass Contextdetritus-client/command/Context
): Promise<boolean>external Promise | boolean[src]
onBeforeRun(
context: Contextclass Contextdetritus-client/command/Context,
args: ParsedArgstype ParsedArgsdetritus-client/command/ParsedArgs
): Promise<boolean>external Promise | boolean[src]
onCancel(
context: Contextclass Contextdetritus-client/command/Context
): Promise<any | Messageclass Messagedetritus-client/structures/Message>external Promise | any | Messageclass Messagedetritus-client/structures/Message[src]
onCancelRun(
context: Contextclass Contextdetritus-client/command/Context,
args: ParsedArgstype ParsedArgsdetritus-client/command/ParsedArgs
): Promise<any | Messageclass Messagedetritus-client/structures/Message>external Promise | any | Messageclass Messagedetritus-client/structures/Message[src]
onError(
context: Contextclass Contextdetritus-client/command/Context,
args: ParsedArgstype ParsedArgsdetritus-client/command/ParsedArgs,
error: any
): Promise<any>external Promise | any[src]
onPermissionsFail(
context: Contextclass Contextdetritus-client/command/Context,
permissions: FailedPermissionstype FailedPermissionsdetritus-client/command/FailedPermissions
): Promise<any | Messageclass Messagedetritus-client/structures/Message>external Promise | any | Messageclass Messagedetritus-client/structures/Message[src]
onPermissionsFailClient(
context: Contextclass Contextdetritus-client/command/Context,
permissions: FailedPermissionstype FailedPermissionsdetritus-client/command/FailedPermissions
): Promise<any | Messageclass Messagedetritus-client/structures/Message>external Promise | any | Messageclass Messagedetritus-client/structures/Message[src]
onRatelimit(
context: Contextclass Contextdetritus-client/command/Context,
ratelimits: Array<CommandRatelimitInfotype CommandRatelimitInfodetritus-client/command/CommandRatelimitInfo>external Array,
metadata: CommandRatelimitMetadatatype CommandRatelimitMetadatadetritus-client/command/CommandRatelimitMetadata
): Promise<any | Messageclass Messagedetritus-client/structures/Message>external Promise | any | Messageclass Messagedetritus-client/structures/Message[src]
run(
context: Contextclass Contextdetritus-client/command/Context,
args: ParsedArgsFinishedtype parameter ParsedArgsFinished
): Promise<any | Messageclass Messagedetritus-client/structures/Message>external Promise | any | Messageclass Messagedetritus-client/structures/Message[src]
onRunError(
context: Contextclass Contextdetritus-client/command/Context,
args: ParsedArgsFinishedtype parameter ParsedArgsFinished,
error: any
): Promise<any | Messageclass Messagedetritus-client/structures/Message>external Promise | any | Messageclass Messagedetritus-client/structures/Message[src]
onSuccess(
context: Contextclass Contextdetritus-client/command/Context,
args: ParsedArgsFinishedtype parameter ParsedArgsFinished
): Promise<any>external Promise | any[src]
onTypeError(
context: Contextclass Contextdetritus-client/command/Context,
args: ParsedArgstype ParsedArgsdetritus-client/command/ParsedArgs,
errors: ParsedErrorstype ParsedErrorsdetritus-client/command/ParsedErrors
): Promise<any | Messageclass Messagedetritus-client/structures/Message>external Promise | any | Messageclass Messagedetritus-client/structures/Message[src]
set aliases(value: Array<string>external Array): void[src]
set args(value: Array<ArgumentOptionsinterface ArgumentOptionsdetritus-client/command/ArgumentOptions>external Array): void[src]
set choices(value: Array<any>external Array | undefined): void[src]
set default(value: ArgumentDefaulttype ArgumentDefaultdetritus-client/command/ArgumentDefault): void[src]
set help(value: string): void[src]
set label(value: string): void[src]
set name(value: string): void[src]
set prefixes(value: Array<string>external Array): void[src]
set type(value: ArgumentTypetype ArgumentTypedetritus-client/command/ArgumentType): void[src]
setAliases(value: Array<string>external Array): Commandtype CommandCommand[src]
setArgs(value: Array<ArgumentOptionsinterface ArgumentOptionsdetritus-client/command/ArgumentOptions>external Array): Commandtype CommandCommand[src]
setChoices(value: Array<any>external Array | undefined): Commandtype CommandCommand[src]
setDefault(value: ArgumentDefaulttype ArgumentDefaultdetritus-client/command/ArgumentDefault): Commandtype CommandCommand[src]
setHelp(value: string): Commandtype CommandCommand[src]
setLabel(value: string): Commandtype CommandCommand[src]
setName(value: string): Commandtype CommandCommand[src]
setPrefixes(value: Array<string>external Array): Commandtype CommandCommand[src]
setType(value: ArgumentTypetype ArgumentTypedetritus-client/command/ArgumentType): Commandclass Commanddetritus-client/command/Command[src]
getArgs(
attributes: CommandAttributesinterface CommandAttributesdetritus-client/CommandAttributes,
context: Contextclass Contextdetritus-client/command/Context
): Promise<{errors: ParsedErrorstype ParsedErrorsdetritus-client/command/ParsedErrors, parsed: ParsedArgstype ParsedArgsdetritus-client/command/ParsedArgs}>external Promise[src]